Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move web content from OSCAL, and other streamlining. (Revised for Release) #1856

Merged
merged 5 commits into from
Jul 25, 2023
Merged

Move web content from OSCAL, and other streamlining. (Revised for Release) #1856

merged 5 commits into from
Jul 25, 2023

Conversation

Compton-US
Copy link
Contributor

@Compton-US Compton-US commented Jul 13, 2023 •
edited by aj-stein-nist
Loading

Committer Notes

This is a corrected PR based on the issues around #1824.

In support of Issue #1802

Currently in rapid prototype mode with the team.

  • Website content moved to OSCAL-Pages project. This project will build and publish the public website.
  • Reference content moved to OSCAL-Reference project. This project will build and publish the developer documentation. AKA OSCAL Reference.
  • OSCAL repo in this branch has been reduced to only the model content.

Remaining to determine:

  • Linking up the websites so that it is least disruptive to the public.
  • The generated xml and json content has been removed from this branch. We need to talk about this, and what is the "right" way moving forward. I think there are a number of options and opinions to consider.
  • Figuring out the entry point into the public website. (linking, landing page, etc)

Benefits:

  • Less activity on the OSCAL project unrelated to models.
  • Will make it easier for the community to monitor.
  • More focused workstreams between model development, website content/education and experiments with models.
  • Depending on how we publish the schemas-and-converters artifact, may make it easier for the public to access and use releases of OSCAL with less tooling.
  • Reference will be in position to be updated and enhanced over time for development use.
  • Public website can update at-will without impacting the OSCAL model project.

All Submissions:

By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.

(For reviewers: The wiki has guidance on code review and overall issue review for completeness.)

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable? A.J. is waving this, N/A.
  • Have you included examples of how to use your new feature(s)? A.J. is waving this, N/A.
  • Have you updated all OSCAL website and readme documentation affected by the changes you made? Changes to the OSCAL website can be made in the docs/content directory of your branch.

Compton-US and others added 2 commits July 13, 2023 11:37
@Compton-US
Adjustment of OSCAL project to support multi-repository approach
c2cb4f0 
- Content was deleted and distributed between OSCAL-Pages and OSCAL-Reference.
- Unnecessary scripts and code were pruned from the repo.
- Workflows were reduced as necessary.
@Compton-US
Fix relative link to profile resolution
db8b3d0
@Compton-US Compton-US changed the title Feature 1802 oscal pages nosquash Move web content from OSCAL, and other streamlining. (Revised for Release) Jul 13, 2023
aj-stein-nist
aj-stein-nist reviewed Jul 13, 2023
View reviewed changes
Copy link
Contributor

@aj-stein-nist aj-stein-nist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am very very happy with this. I will test more but I assume we need to answer the one big question before moving forward.

.github/workflows/workflow-generate-metaschema-resources.yml Outdated Show resolved Hide resolved
.gitmodules Outdated
Comment on lines 1 to 3
[submodule "build/metaschema"]
path = build/metaschema
url = https://github.com/usnistgov/metaschema.git
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe blocking 🤷: we still need to figure out this piece (stick with this, move to metaschema-xslt in the same PR) before we can formally, merge, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll take guidance here. I'm not quite as confident on the best course.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikitawootten-nist with usnistgov/metaschema-xslt#45 on the way and close to setting off the baking timer in the oven, I assume we are close to ready to switch out this sprint?

@aj-stein-nist aj-stein-nist mentioned this pull request Jul 14, 2023
Merged
@nikitawootten-nist nikitawootten-nist mentioned this pull request Jul 21, 2023
Merged
20 tasks
@nikitawootten-nist @wendellpiez
@JustKuzya @Compton-US @aj-stein-nist
Revamp CI/CD Infrastructure, Simplify Build (#1857), Fix JSON->XML Co…
d4e5c5c 
…nverter (#1849)

* Replaced `metaschema` submodule with `metaschema-xslt`
    * The `metaschema-xslt` version also fixes #1849
* Removed all bespoke scripts and replaced them with Makefile targets
* Changed CI infrastructure to use the new Makefile scripts
* Removed Dockerfile and infrastructure as it is no longer needed
* Changed model version to `1.1.0`

Co-authored-by: Wendell Piez <[email protected]>
Co-authored-by: Dmitry Cousin <[email protected]>
Co-authored-by: Chris Compton <[email protected]>
Co-authored-by: A.J. Stein <[email protected]>
This was linked to issues Jul 25, 2023
SPIKE: Manage website content from separate repository #1802
Closed
JSON->XML conversion adds nm:ERROR when using json instead of file input #1849
Closed
nikitawootten-nist
nikitawootten-nist approved these changes Jul 25, 2023
View reviewed changes
Copy link
Contributor

@nikitawootten-nist nikitawootten-nist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on previous discussions we've had, this all looks great!

@nikitawootten-nist nikitawootten-nist merged commit d19aedf into develop Jul 25, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aj-stein-nist aj-stein-nist aj-stein-nist left review comments

@nikitawootten-nist nikitawootten-nist nikitawootten-nist approved these changes

@wendellpiez wendellpiez Awaiting requested review from wendellpiez

@iMichaela iMichaela Awaiting requested review from iMichaela

Assignees
No one assigned
Labels
None yet
Projects
NIST OSCAL Work Board
Status: Done
Milestone
No milestone
3 participants
@Compton-US @nikitawootten-nist @aj-stein-nist